home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / spider15.zip / SPIDER.DOC next >
Text File  |  1992-01-24  |  11KB  |  337 lines
  1.  
  2. * Spider * 1.15 *
  3. * Copyright (c) W. Feller 1991,92 - Planet Earth *
  4.  
  5. Spider is a program which may be used to rotate a series of files
  6. to specific targets.  It can be used to shuffle Prelog, Hello and
  7. Goodbye screens as well as Menus and Bulletins.  Spider can be
  8. used for any type of BBS, or any situation where you would like
  9. to replace one or more files in rotation.
  10.  
  11. Features:
  12.  
  13. Random rotation;  Spider never copies the same file twice in a row.
  14. This option's bitchen when used to generate a "we pick" type of
  15. door.  It's cool for door and bulletin menus too.
  16.  
  17. File Headers & Footers;  No more typing @JUNK@ at the top of every
  18. screen you plan to revolve.  Spider can include file headers and
  19. footers to make it easy on your maintenance.
  20.  
  21. Log options;  Keep a record of the time, date and copy operations.
  22.  
  23. Setup option;  This will display the settings defined by the .DEF
  24. and .DAT files for detailed examination while setting up.
  25.  
  26. *
  27. Files included in this package:
  28. ------------------------------
  29.  
  30. Spider.EXE ∙∙∙∙∙ The actual Spider program
  31. Spider.DOC ∙∙∙∙∙ This .DOC file, instructions for Spider
  32.  
  33. *
  34. Spider Basics
  35. -------------
  36.  
  37. Spider rotates the files designated in a .DEF (definition)
  38. file, according to the values in a .DAT (data) file.  Spider
  39. must have the Spider.EXE, a CONFIG.DEF, and a CONFIG.DAT
  40. in order to run.
  41.  
  42. Config.DEF   <--- definition file (file names, paths)
  43. Config.DAT   <--- data file (count numbers)
  44.  
  45. The following files may be made up for Spider's use, but are
  46. not necessary for Spider's operation.
  47.  
  48. Config.HDR   <--- header file
  49. Config.FTR   <--- footer file
  50.  
  51. Config.LOG   <--- log of operations (Spider generated)
  52.  
  53. *
  54. The Spider Command Line
  55. -----------------------
  56.  
  57. Spider [/Switch] FileName
  58.  
  59. A typical Spider command line would look as follows.
  60.  
  61. C:\>Spider Filename
  62.  
  63. or
  64.  
  65. C:\>Spider /S Config
  66.  
  67. The command simply includes Spider with the name of a con-
  68. figuration file following.  The configuration filename on
  69. the command line MUST NOT INCLUDE an extention.
  70.  
  71. The switches provide logging and setup previewing options.
  72. The /L switch will log all operations to a Config.LOG file.
  73. The /S switch provides setup information.
  74.  
  75. Spider uses two files in operation, the .DEF file and the .DAT
  76. file.  The definition file (.DEF) is a list of the paths to
  77. both the source and target files, and a list of the source files.
  78.  
  79. --------------------------
  80. The .DEF type files contain 3 primary pieces of information
  81. used by Spider to shuffle the appropriate files.  The file name
  82. portion can be any legal DOS file name.  The extention must be
  83. .DEF for Spider to work.
  84.  
  85. .DEF File Structure
  86. -------------------
  87. The .DEF file is an ASCII file which maybe made using an ASCII
  88. editor such as Qedit or Ted.  The structure of this file is as
  89. follows;
  90.  
  91. Target                  ]--------------- Definition 1
  92. Source Directory        ]
  93. Source File             ]
  94. Source File             ]
  95. .                       ]
  96. .                       ]
  97. .                       ]
  98. Target             ]------ Definition 2
  99. Source Directory   ]
  100. Source File        ]
  101. .                  ]
  102. .                  ]
  103. Target                  ]---------------- Definition 3
  104. .                       ]
  105. & so on to a maximum of 1000 lines ...
  106.  
  107. Any combination of definitions may be made up as long as the
  108. total length of the .DEF file does not exceed 1000 lines.
  109.  
  110. Each definition is made up of 3 types of information;
  111.  
  112.         1) There can be up to 50 definitions per .DEF file.
  113.            Each group of definitions are listed
  114.  
  115.         1)  Target file (ex: > Drive:\Path\Filename.EXT)
  116.  
  117.         Notice the greater than, ">" symbol is the first char-
  118.         acter in the line.  Each target file defined must have
  119.         this, ">" sign preceeding it.
  120.  
  121.         2)  Source path (ex:  Drive:\Path\)
  122.  
  123.         Must include the full path to the source files. Be
  124.         sure to ADD the forward slash "\" at the end!  If
  125.         there is no path to the source files, be sure to leave
  126.         the line following the target file blank.
  127.  
  128.         3)  Source files (ex:  Hello1.001)
  129.                          (ex:  Hello1.002)
  130.                          (ex:  Hello1.003)
  131.                          (ex:  Hello1.004)
  132.  
  133.         The source files are listed one after another,
  134.         immediatley after the target and the source path.
  135.         There can be as few as 2 files per definition, or
  136.         as many as 500 files.  They may not have a path
  137.         included in the filename.  Also, they do not have
  138.         to have similar names as shown.
  139.  
  140. Here is an example of a .DEF file.  It contains two definitions.
  141. The first rotates a list of 5 source files into a target, and
  142. the second rotates a list of 3 source files.
  143.  
  144. Sample.DEF file                   Remarks (do not include in file)
  145. -------------------------------------------------------------------
  146. > c:\wc30\bull\bulletin.bbs       Target file #1 (preceeded by ">")
  147. \disp2\                           Source file path
  148. Bullet.01                         Source file 1
  149. Bullet.02                           "     "   2
  150. Bullet.03                           "     "   3
  151. Bullet.04                           "     "   4
  152. Bullet.05                           "     "   5
  153. > c:\wc30\disp\prelog.bbs         Target file #2
  154. \disp2\color\*                    Source file path
  155. Prelog.001                        Source file 1
  156. Prelog.002                          "     "   2
  157. Prelog.003                          "     "   3
  158. ------------------------EOF----------------------------------------
  159. (Remember that you can make each .DEF file 1000 lines max.)
  160.  
  161. *
  162. The Data File (.DAT)
  163. --------------------
  164. The .DAT files contain the numbers used to keep track and rotate
  165. the source files listed in the .DEF file.  Each .DEF file MUST
  166. have a corresponding .DAT file.
  167.  
  168. The .DAT files are easy to make.  There are two rows of information
  169. required for each definition described in the .DEF file.  The first
  170. row gives us the total files available for rotating, while the second
  171. row tells us the source file number to copy to the target.  The
  172. example .DAT file following corresponds to the example .DEF file.
  173.  
  174. Sample.DAT file      Remarks (do not include in file)
  175. ---------------------------------------------------------------
  176. 5                -   Total number of source files in definition
  177. 1                -   Copy source #1 to target
  178. 3                -   Total number of source files in definition
  179. 1                -   Copy source #1 to target
  180.  
  181. It is easiest to set the source number to 1 when first setting up Spider.
  182.  
  183. There's not too much to a data file, just the number of source files,
  184. and the #1 for each definition.  Spider uses this file to keep track
  185. of which file to copy.
  186.  
  187. *
  188. Random Rotation
  189. -------------------------------------------
  190. Spider now can randomly choose a file to rotate!  No file will be
  191. copied from twice in a row.  Just put an "*" after the copy source
  192. (usually 1) to let Spider know to choose one of the source files
  193. on it's own.
  194.  
  195. Sample.DAT file (Showing use of * to generate a random rotation)
  196. ----------------------------------------------------------------
  197. 5                -   Total number of source files in definition
  198. 1                -   Copy source #1 to target (Normal rotation)
  199. 3                -   Total number of source files in definition
  200. 1*               -   Copy source #1 to target (Random rotation)
  201.  
  202. -2.0-
  203.  
  204. Sample.DAT file (Showing use of + for multiple source files)
  205. ------------------------------------------------------------
  206. 5+
  207.         3
  208.         1*
  209.         4
  210.         1
  211. 1
  212. 3
  213. 1*
  214.  
  215. *
  216. Switch Options
  217. --------------
  218. /L  Log    - Will log all copy operations to a file named
  219.              FileName.LOG.
  220.  
  221. /S  Setup  - This sends an echo to the screen, but does not
  222.              perform any copy functions.  This will help make
  223.              setup easier.
  224.  
  225. *
  226. Headers & Footers
  227. -----------------
  228. One header and one footer file can be included in each definition
  229. file.  Spider will attach the file FILENAME.HDR and/or FILENAME.FTR
  230. to the top and bottom of your target file.
  231.  
  232. This feature is used by placing a "+","-" or "*" as the last
  233. character in the source path line in the .DEF file.
  234.  
  235.   +, will include the config FileName.HDR to the front of the target
  236.      file.
  237.  
  238.   -, will include the config FileName.FTR to the end of the target
  239.      file.
  240.  
  241.   *, will include both as described.
  242.  
  243. .DEF header/footer examples
  244.  
  245. > C:\target
  246. \Path\* <------ tells Spider to include both the Config.HDR &
  247.                 Config.FTR file
  248.  
  249. \Path\+ <------ include Config.HDR only
  250.  
  251. \Path\- <------ include Config.FTR only
  252.  
  253. ex;
  254.  
  255. > c:\target
  256. \path\* <-- Merge both header and footer into target file.
  257. src.001
  258. src.002 ...
  259.  
  260. There may be only 1 header and footer file per .DEF file.
  261.  
  262. |-- Source Path ------|-- Target File --|
  263.  
  264. +--------+                 +--------+
  265. | Header |---------------> | Header |
  266. +--------+      .--------> | Source |
  267. +--------+      |  .-----> | Footer |
  268. | Source |------'  |       +--------+
  269. |  .001  |         |
  270. +--------+         |
  271. +--------+         |
  272. | Source |         |
  273. |  .002  |         |
  274. +--------+ ...     |
  275. +--------+         |
  276. | Footer |---------'
  277. +--------+
  278.  
  279. *
  280. Notes on batch files and events
  281. -------------------------------
  282. Spider works very well from the postcall.bat in WildCat!.  Several
  283. configurations can be included.  Include Spider in a door batch
  284. file, have a different menu or set of menus when the caller comes
  285. back.  Spider works great on copy door??.bat files to a door??.bat
  286. that runs a random pick door.
  287.  
  288. Ex.  PostCall.BAT
  289.  
  290. CD\Spider
  291. Spider Bullets
  292. Spider Prelog
  293. Spider Goodbye
  294.  
  295. or  (using switches)
  296.  
  297. CD\Spider
  298. Spider /L Bullets
  299. Spider /S/L Goodbye
  300.  
  301. Spider also works well from DOS hooks, or as an event from within WC!.
  302.  
  303. *
  304. Summary
  305. -------
  306. Spider is used to rotate files from various sources to designated
  307. targets.  Spider requires Spider.EXE and similar named .DEF and.DAT
  308. files in order to operate.  The total length of the .DEF file
  309. may not be more than 1000 lines long.  The ability to use different
  310. configurations provides unlimited rotation possibilities.
  311.  
  312. *
  313. Disk-Claimer
  314. ------------
  315. Spider is as bug-free as I could possibly make it.  Be aware that it
  316. does write over the target files specified in the .DEF files.  Pay
  317. attention to the filenames you input.  The errors you make are your
  318. own, and you are responsible for them.  Not me.
  319.  
  320. *
  321. Registration
  322. ------------
  323. Please register Spider by sending a check or money order for $5.95 to,
  324.  
  325. Walter Feller
  326. 6003 Saturn
  327. Mira Loma, Ca. 91752
  328.  
  329. Please note that it is for the Spider program, your version number, and
  330. include a mailing address.
  331.  
  332. *
  333. The latest copy of Spider, and author support may be found on,..
  334.  
  335. Another BBS (619) 244-3675, Hesperia Ca. -  24/12/3 - N81 - 24 hrs.
  336.  
  337.